/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.jetspeed.decoration;

/**
 * PageEditAccess representing current Page edit state.
 * 
 * @author <href a="mailto:ate@douma.nu">Ate Douma</a>
 * @version $Id$
 */
public interface PageEditAccess 
{
    /**
     * @return true if page editing is allowed
     */
    boolean isEditAllowed();
    
    /**
     * @return true if page in edit mode
     */
    boolean isEditing();
    
    /**
     * Switch the Page edit state.
     * @param editing intended Page edit state
     * @throws SecurityException when trying to set edit state while not allowed
     */
    void setEditing(boolean editing) throws SecurityException;
}
